<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Ipopt: src/Interfaces/IpStdCInterface.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  $(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
  extensions: ["tex2jax.js"],
  jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 40px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Ipopt Documentation
   &#160;<!--span id="projectnumber">3.14.17</span-->
   </div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('IpStdCInterface_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle"><div class="title">IpStdCInterface.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;stdbool.h&gt;</code><br />
<code>#include &quot;<a class="el" href="IpoptConfig_8h_source.html">IpoptConfig.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="IpTypes_8h_source.html">IpTypes.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="IpReturnCodes_8h_source.html">IpReturnCodes.h</a>&quot;</code><br />
</div>
<p><a href="IpStdCInterface_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:aa8cecfc5c5c054d2875c03e77b7be15d" id="r_aa8cecfc5c5c054d2875c03e77b7be15d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpStdCInterface_8h.html#aa8cecfc5c5c054d2875c03e77b7be15d">TRUE</a>&#160;&#160;&#160;(1)</td></tr>
<tr class="separator:aa8cecfc5c5c054d2875c03e77b7be15d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa93f0eb578d23995850d61f7d61c55c1" id="r_aa93f0eb578d23995850d61f7d61c55c1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpStdCInterface_8h.html#aa93f0eb578d23995850d61f7d61c55c1">FALSE</a>&#160;&#160;&#160;(0)</td></tr>
<tr class="separator:aa93f0eb578d23995850d61f7d61c55c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ae32712b8d014ab2144fee84432e4a347" id="r_ae32712b8d014ab2144fee84432e4a347"><td class="memItemLeft" align="right" valign="top">typedef struct IpoptProblemInfo *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpStdCInterface_8h.html#ae32712b8d014ab2144fee84432e4a347">IpoptProblem</a></td></tr>
<tr class="memdesc:ae32712b8d014ab2144fee84432e4a347"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to an <a class="el" href="namespaceIpopt.html" title="This file contains a base class for all exceptions and a set of macros to help with exceptions.">Ipopt</a> Problem.  <br /></td></tr>
<tr class="separator:ae32712b8d014ab2144fee84432e4a347"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a76a8b016e5ad61faf9062cc387df5016" id="r_a76a8b016e5ad61faf9062cc387df5016"><td class="memItemLeft" align="right" valign="top">typedef bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpStdCInterface_8h.html#a76a8b016e5ad61faf9062cc387df5016">Bool</a></td></tr>
<tr class="memdesc:a76a8b016e5ad61faf9062cc387df5016"><td class="mdescLeft">&#160;</td><td class="mdescRight">define a boolean type for C  <br /></td></tr>
<tr class="separator:a76a8b016e5ad61faf9062cc387df5016"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34729529d9e43f5954710164cafe4894" id="r_a34729529d9e43f5954710164cafe4894"><td class="memItemLeft" align="right" valign="top">typedef void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpStdCInterface_8h.html#a34729529d9e43f5954710164cafe4894">UserDataPtr</a></td></tr>
<tr class="memdesc:a34729529d9e43f5954710164cafe4894"><td class="mdescLeft">&#160;</td><td class="mdescRight">A pointer for anything that is to be passed between the called and individual callback function.  <br /></td></tr>
<tr class="separator:a34729529d9e43f5954710164cafe4894"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab30234055c386ab38a7f50fffea65ed" id="r_aab30234055c386ab38a7f50fffea65ed"><td class="memItemLeft" align="right" valign="top">typedef bool(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpStdCInterface_8h.html#aab30234055c386ab38a7f50fffea65ed">Eval_F_CB</a>) (<a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> n, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *x, bool new_x, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *obj_value, <a class="el" href="IpStdCInterface_8h.html#a34729529d9e43f5954710164cafe4894">UserDataPtr</a> user_data)</td></tr>
<tr class="memdesc:aab30234055c386ab38a7f50fffea65ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type defining the callback function for evaluating the value of the objective function.  <br /></td></tr>
<tr class="separator:aab30234055c386ab38a7f50fffea65ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae26561e1d9045d17521cb5f1e9992abb" id="r_ae26561e1d9045d17521cb5f1e9992abb"><td class="memItemLeft" align="right" valign="top">typedef bool(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpStdCInterface_8h.html#ae26561e1d9045d17521cb5f1e9992abb">Eval_Grad_F_CB</a>) (<a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> n, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *x, bool new_x, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *grad_f, <a class="el" href="IpStdCInterface_8h.html#a34729529d9e43f5954710164cafe4894">UserDataPtr</a> user_data)</td></tr>
<tr class="memdesc:ae26561e1d9045d17521cb5f1e9992abb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type defining the callback function for evaluating the gradient of the objective function.  <br /></td></tr>
<tr class="separator:ae26561e1d9045d17521cb5f1e9992abb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5daaee1b7bfa5667670e788a91cae09f" id="r_a5daaee1b7bfa5667670e788a91cae09f"><td class="memItemLeft" align="right" valign="top">typedef bool(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpStdCInterface_8h.html#a5daaee1b7bfa5667670e788a91cae09f">Eval_G_CB</a>) (<a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> n, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *x, bool new_x, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> m, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *g, <a class="el" href="IpStdCInterface_8h.html#a34729529d9e43f5954710164cafe4894">UserDataPtr</a> user_data)</td></tr>
<tr class="memdesc:a5daaee1b7bfa5667670e788a91cae09f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type defining the callback function for evaluating the value of the constraint functions.  <br /></td></tr>
<tr class="separator:a5daaee1b7bfa5667670e788a91cae09f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdc0651b551e43ee347d208a4125d28c" id="r_afdc0651b551e43ee347d208a4125d28c"><td class="memItemLeft" align="right" valign="top">typedef bool(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpStdCInterface_8h.html#afdc0651b551e43ee347d208a4125d28c">Eval_Jac_G_CB</a>) (<a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> n, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *x, bool new_x, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> m, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> nele_jac, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> *iRow, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> *jCol, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *values, <a class="el" href="IpStdCInterface_8h.html#a34729529d9e43f5954710164cafe4894">UserDataPtr</a> user_data)</td></tr>
<tr class="memdesc:afdc0651b551e43ee347d208a4125d28c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type defining the callback function for evaluating the Jacobian of the constrant functions.  <br /></td></tr>
<tr class="separator:afdc0651b551e43ee347d208a4125d28c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a8d4d98e2ba3178a1a8772d8dd4d3c2" id="r_a5a8d4d98e2ba3178a1a8772d8dd4d3c2"><td class="memItemLeft" align="right" valign="top">typedef bool(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpStdCInterface_8h.html#a5a8d4d98e2ba3178a1a8772d8dd4d3c2">Eval_H_CB</a>) (<a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> n, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *x, bool new_x, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> obj_factor, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> m, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *lambda, bool new_lambda, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> nele_hess, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> *iRow, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> *jCol, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *values, <a class="el" href="IpStdCInterface_8h.html#a34729529d9e43f5954710164cafe4894">UserDataPtr</a> user_data)</td></tr>
<tr class="memdesc:a5a8d4d98e2ba3178a1a8772d8dd4d3c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type defining the callback function for evaluating the Hessian of the Lagrangian function.  <br /></td></tr>
<tr class="separator:a5a8d4d98e2ba3178a1a8772d8dd4d3c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a2bc6b1dc188466a5eed53a50dd15df" id="r_a0a2bc6b1dc188466a5eed53a50dd15df"><td class="memItemLeft" align="right" valign="top">typedef bool(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpStdCInterface_8h.html#a0a2bc6b1dc188466a5eed53a50dd15df">Intermediate_CB</a>) (<a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> alg_mod, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> iter_count, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> obj_value, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> inf_pr, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> inf_du, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> mu, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> d_norm, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> regularization_size, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> alpha_du, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> alpha_pr, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> ls_trials, <a class="el" href="IpStdCInterface_8h.html#a34729529d9e43f5954710164cafe4894">UserDataPtr</a> user_data)</td></tr>
<tr class="memdesc:a0a2bc6b1dc188466a5eed53a50dd15df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type defining the callback function for giving intermediate execution control to the user.  <br /></td></tr>
<tr class="separator:a0a2bc6b1dc188466a5eed53a50dd15df"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ad1c7c5bba4e9ca11142b12c1d434764e" id="r_ad1c7c5bba4e9ca11142b12c1d434764e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a> <a class="el" href="IpStdCInterface_8h.html#ae32712b8d014ab2144fee84432e4a347">IpoptProblem</a> <a class="el" href="IpTypes_8h.html#ae7eaa5fbc2133bb2a78973a87cc7bb5b">IPOPT_CALLCONV</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpStdCInterface_8h.html#ad1c7c5bba4e9ca11142b12c1d434764e">CreateIpoptProblem</a> (<a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> n, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *x_L, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *x_U, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> m, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *g_L, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *g_U, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> nele_jac, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> nele_hess, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> index_style, <a class="el" href="IpStdCInterface_8h.html#aab30234055c386ab38a7f50fffea65ed">Eval_F_CB</a> eval_f, <a class="el" href="IpStdCInterface_8h.html#a5daaee1b7bfa5667670e788a91cae09f">Eval_G_CB</a> eval_g, <a class="el" href="IpStdCInterface_8h.html#ae26561e1d9045d17521cb5f1e9992abb">Eval_Grad_F_CB</a> eval_grad_f, <a class="el" href="IpStdCInterface_8h.html#afdc0651b551e43ee347d208a4125d28c">Eval_Jac_G_CB</a> eval_jac_g, <a class="el" href="IpStdCInterface_8h.html#a5a8d4d98e2ba3178a1a8772d8dd4d3c2">Eval_H_CB</a> eval_h)</td></tr>
<tr class="memdesc:ad1c7c5bba4e9ca11142b12c1d434764e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function for creating a new <a class="el" href="namespaceIpopt.html" title="This file contains a base class for all exceptions and a set of macros to help with exceptions.">Ipopt</a> Problem object.  <br /></td></tr>
<tr class="separator:ad1c7c5bba4e9ca11142b12c1d434764e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2776b701c950d9700509f1e601d787f6" id="r_a2776b701c950d9700509f1e601d787f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a> void <a class="el" href="IpTypes_8h.html#ae7eaa5fbc2133bb2a78973a87cc7bb5b">IPOPT_CALLCONV</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpStdCInterface_8h.html#a2776b701c950d9700509f1e601d787f6">FreeIpoptProblem</a> (<a class="el" href="IpStdCInterface_8h.html#ae32712b8d014ab2144fee84432e4a347">IpoptProblem</a> ipopt_problem)</td></tr>
<tr class="memdesc:a2776b701c950d9700509f1e601d787f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Method for freeing a previously created IpoptProblem.  <br /></td></tr>
<tr class="separator:a2776b701c950d9700509f1e601d787f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6b7c62bfbc8dea71b3a6f724c36b377" id="r_ab6b7c62bfbc8dea71b3a6f724c36b377"><td class="memItemLeft" align="right" valign="top"><a class="el" href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a> bool <a class="el" href="IpTypes_8h.html#ae7eaa5fbc2133bb2a78973a87cc7bb5b">IPOPT_CALLCONV</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpStdCInterface_8h.html#ab6b7c62bfbc8dea71b3a6f724c36b377">AddIpoptStrOption</a> (<a class="el" href="IpStdCInterface_8h.html#ae32712b8d014ab2144fee84432e4a347">IpoptProblem</a> ipopt_problem, char *keyword, char *val)</td></tr>
<tr class="memdesc:ab6b7c62bfbc8dea71b3a6f724c36b377"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function for adding a string option.  <br /></td></tr>
<tr class="separator:ab6b7c62bfbc8dea71b3a6f724c36b377"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7af9acc5df419794044bc4c6717a89ca" id="r_a7af9acc5df419794044bc4c6717a89ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a> bool <a class="el" href="IpTypes_8h.html#ae7eaa5fbc2133bb2a78973a87cc7bb5b">IPOPT_CALLCONV</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpStdCInterface_8h.html#a7af9acc5df419794044bc4c6717a89ca">AddIpoptNumOption</a> (<a class="el" href="IpStdCInterface_8h.html#ae32712b8d014ab2144fee84432e4a347">IpoptProblem</a> ipopt_problem, char *keyword, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> val)</td></tr>
<tr class="memdesc:a7af9acc5df419794044bc4c6717a89ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function for adding a Number option.  <br /></td></tr>
<tr class="separator:a7af9acc5df419794044bc4c6717a89ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a408cfbc4c2e69def583fd8c0ca85d88c" id="r_a408cfbc4c2e69def583fd8c0ca85d88c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a> bool <a class="el" href="IpTypes_8h.html#ae7eaa5fbc2133bb2a78973a87cc7bb5b">IPOPT_CALLCONV</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpStdCInterface_8h.html#a408cfbc4c2e69def583fd8c0ca85d88c">AddIpoptIntOption</a> (<a class="el" href="IpStdCInterface_8h.html#ae32712b8d014ab2144fee84432e4a347">IpoptProblem</a> ipopt_problem, char *keyword, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> val)</td></tr>
<tr class="memdesc:a408cfbc4c2e69def583fd8c0ca85d88c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function for adding an Integer option.  <br /></td></tr>
<tr class="separator:a408cfbc4c2e69def583fd8c0ca85d88c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a217bdf5c36c19c81b44fab50d8af8a8a" id="r_a217bdf5c36c19c81b44fab50d8af8a8a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a> bool <a class="el" href="IpTypes_8h.html#ae7eaa5fbc2133bb2a78973a87cc7bb5b">IPOPT_CALLCONV</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpStdCInterface_8h.html#a217bdf5c36c19c81b44fab50d8af8a8a">OpenIpoptOutputFile</a> (<a class="el" href="IpStdCInterface_8h.html#ae32712b8d014ab2144fee84432e4a347">IpoptProblem</a> ipopt_problem, char *file_name, int print_level)</td></tr>
<tr class="memdesc:a217bdf5c36c19c81b44fab50d8af8a8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function for opening an output file for a given name with given printlevel.  <br /></td></tr>
<tr class="separator:a217bdf5c36c19c81b44fab50d8af8a8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe4f90a0c6f89253924c7afb067f87e2" id="r_afe4f90a0c6f89253924c7afb067f87e2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a> bool <a class="el" href="IpTypes_8h.html#ae7eaa5fbc2133bb2a78973a87cc7bb5b">IPOPT_CALLCONV</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpStdCInterface_8h.html#afe4f90a0c6f89253924c7afb067f87e2">SetIpoptProblemScaling</a> (<a class="el" href="IpStdCInterface_8h.html#ae32712b8d014ab2144fee84432e4a347">IpoptProblem</a> ipopt_problem, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> obj_scaling, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *x_scaling, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *g_scaling)</td></tr>
<tr class="memdesc:afe4f90a0c6f89253924c7afb067f87e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Optional function for setting scaling parameter for the NLP.  <br /></td></tr>
<tr class="separator:afe4f90a0c6f89253924c7afb067f87e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab86b55545fa3e0232a0e646409e0e82b" id="r_ab86b55545fa3e0232a0e646409e0e82b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a> bool <a class="el" href="IpTypes_8h.html#ae7eaa5fbc2133bb2a78973a87cc7bb5b">IPOPT_CALLCONV</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpStdCInterface_8h.html#ab86b55545fa3e0232a0e646409e0e82b">SetIntermediateCallback</a> (<a class="el" href="IpStdCInterface_8h.html#ae32712b8d014ab2144fee84432e4a347">IpoptProblem</a> ipopt_problem, <a class="el" href="IpStdCInterface_8h.html#a0a2bc6b1dc188466a5eed53a50dd15df">Intermediate_CB</a> intermediate_cb)</td></tr>
<tr class="memdesc:ab86b55545fa3e0232a0e646409e0e82b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setting a callback function for the "intermediate callback" method in the TNLP.  <br /></td></tr>
<tr class="separator:ab86b55545fa3e0232a0e646409e0e82b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a68928c505f008c1245088bca5b7b16" id="r_a5a68928c505f008c1245088bca5b7b16"><td class="memItemLeft" align="right" valign="top"><a class="el" href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a> enum <a class="el" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7">ApplicationReturnStatus</a> <a class="el" href="IpTypes_8h.html#ae7eaa5fbc2133bb2a78973a87cc7bb5b">IPOPT_CALLCONV</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpStdCInterface_8h.html#a5a68928c505f008c1245088bca5b7b16">IpoptSolve</a> (<a class="el" href="IpStdCInterface_8h.html#ae32712b8d014ab2144fee84432e4a347">IpoptProblem</a> ipopt_problem, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *x, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *g, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *obj_val, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *mult_g, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *mult_x_L, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *mult_x_U, <a class="el" href="IpStdCInterface_8h.html#a34729529d9e43f5954710164cafe4894">UserDataPtr</a> user_data)</td></tr>
<tr class="memdesc:a5a68928c505f008c1245088bca5b7b16"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function calling the <a class="el" href="namespaceIpopt.html" title="This file contains a base class for all exceptions and a set of macros to help with exceptions.">Ipopt</a> optimization algorithm for a problem previously defined with CreateIpoptProblem.  <br /></td></tr>
<tr class="separator:a5a68928c505f008c1245088bca5b7b16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf68350650b7a893061e110ab0e9264f" id="r_acf68350650b7a893061e110ab0e9264f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a> bool <a class="el" href="IpTypes_8h.html#ae7eaa5fbc2133bb2a78973a87cc7bb5b">IPOPT_CALLCONV</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpStdCInterface_8h.html#acf68350650b7a893061e110ab0e9264f">GetIpoptCurrentIterate</a> (<a class="el" href="IpStdCInterface_8h.html#ae32712b8d014ab2144fee84432e4a347">IpoptProblem</a> ipopt_problem, bool scaled, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> n, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *x, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *z_L, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *z_U, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> m, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *g, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *lambda)</td></tr>
<tr class="memdesc:acf68350650b7a893061e110ab0e9264f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get primal and dual variable values of the current iterate.  <br /></td></tr>
<tr class="separator:acf68350650b7a893061e110ab0e9264f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae505cff0e907b9049062f665dadd8be9" id="r_ae505cff0e907b9049062f665dadd8be9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a> bool <a class="el" href="IpTypes_8h.html#ae7eaa5fbc2133bb2a78973a87cc7bb5b">IPOPT_CALLCONV</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpStdCInterface_8h.html#ae505cff0e907b9049062f665dadd8be9">GetIpoptCurrentViolations</a> (<a class="el" href="IpStdCInterface_8h.html#ae32712b8d014ab2144fee84432e4a347">IpoptProblem</a> ipopt_problem, bool scaled, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> n, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *x_L_violation, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *x_U_violation, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *compl_x_L, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *compl_x_U, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *grad_lag_x, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> m, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *nlp_constraint_violation, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *compl_g)</td></tr>
<tr class="memdesc:ae505cff0e907b9049062f665dadd8be9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get primal and dual infeasibility of the current iterate.  <br /></td></tr>
<tr class="separator:ae505cff0e907b9049062f665dadd8be9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:ab974f23c40ccaad0dacd611e3f4885e9" id="r_ab974f23c40ccaad0dacd611e3f4885e9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="IpTypes_8h.html#a24c578b20e2cd4eeb0060056ea13cbe5">IPOPT_DEPRECATED</a> typedef <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpStdCInterface_8h.html#ab974f23c40ccaad0dacd611e3f4885e9">Number</a></td></tr>
<tr class="memdesc:ab974f23c40ccaad0dacd611e3f4885e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type for all number.  <br /></td></tr>
<tr class="separator:ab974f23c40ccaad0dacd611e3f4885e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3aa63858b3377c5aaf789a43e5b47b5" id="r_ac3aa63858b3377c5aaf789a43e5b47b5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="IpTypes_8h.html#a24c578b20e2cd4eeb0060056ea13cbe5">IPOPT_DEPRECATED</a> typedef int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpStdCInterface_8h.html#ac3aa63858b3377c5aaf789a43e5b47b5">Index</a></td></tr>
<tr class="memdesc:ac3aa63858b3377c5aaf789a43e5b47b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type for all indices.  <br /></td></tr>
<tr class="separator:ac3aa63858b3377c5aaf789a43e5b47b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a981fcddf5a1e9bbdc3d71ef0f994259b" id="r_a981fcddf5a1e9bbdc3d71ef0f994259b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="IpTypes_8h.html#a24c578b20e2cd4eeb0060056ea13cbe5">IPOPT_DEPRECATED</a> typedef int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="IpStdCInterface_8h.html#a981fcddf5a1e9bbdc3d71ef0f994259b">Int</a></td></tr>
<tr class="memdesc:a981fcddf5a1e9bbdc3d71ef0f994259b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type for all integers.  <br /></td></tr>
<tr class="separator:a981fcddf5a1e9bbdc3d71ef0f994259b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="aa8cecfc5c5c054d2875c03e77b7be15d" name="aa8cecfc5c5c054d2875c03e77b7be15d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8cecfc5c5c054d2875c03e77b7be15d">&#9670;&#160;</a></span>TRUE</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define TRUE&#160;&#160;&#160;(1)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="IpStdCInterface_8h_source.html#l00057">57</a> of file <a class="el" href="IpStdCInterface_8h_source.html">IpStdCInterface.h</a>.</p>

</div>
</div>
<a id="aa93f0eb578d23995850d61f7d61c55c1" name="aa93f0eb578d23995850d61f7d61c55c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa93f0eb578d23995850d61f7d61c55c1">&#9670;&#160;</a></span>FALSE</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define FALSE&#160;&#160;&#160;(0)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="IpStdCInterface_8h_source.html#l00061">61</a> of file <a class="el" href="IpStdCInterface_8h_source.html">IpStdCInterface.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ae32712b8d014ab2144fee84432e4a347" name="ae32712b8d014ab2144fee84432e4a347"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae32712b8d014ab2144fee84432e4a347">&#9670;&#160;</a></span>IpoptProblem</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct IpoptProblemInfo* <a class="el" href="IpStdCInterface_8h.html#ae32712b8d014ab2144fee84432e4a347">IpoptProblem</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Pointer to an <a class="el" href="namespaceIpopt.html" title="This file contains a base class for all exceptions and a set of macros to help with exceptions.">Ipopt</a> Problem. </p>

<p class="definition">Definition at line <a class="el" href="IpStdCInterface_8h_source.html#l00049">49</a> of file <a class="el" href="IpStdCInterface_8h_source.html">IpStdCInterface.h</a>.</p>

</div>
</div>
<a id="a76a8b016e5ad61faf9062cc387df5016" name="a76a8b016e5ad61faf9062cc387df5016"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a76a8b016e5ad61faf9062cc387df5016">&#9670;&#160;</a></span>Bool</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef bool <a class="el" href="IpStdCInterface_8h.html#a76a8b016e5ad61faf9062cc387df5016">Bool</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>define a boolean type for C </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000019">Deprecated:</a></b></dt><dd>Use bool instead. </dd></dl>

<p class="definition">Definition at line <a class="el" href="IpStdCInterface_8h_source.html#l00054">54</a> of file <a class="el" href="IpStdCInterface_8h_source.html">IpStdCInterface.h</a>.</p>

</div>
</div>
<a id="a34729529d9e43f5954710164cafe4894" name="a34729529d9e43f5954710164cafe4894"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34729529d9e43f5954710164cafe4894">&#9670;&#160;</a></span>UserDataPtr</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void* <a class="el" href="IpStdCInterface_8h.html#a34729529d9e43f5954710164cafe4894">UserDataPtr</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>A pointer for anything that is to be passed between the called and individual callback function. </p>

<p class="definition">Definition at line <a class="el" href="IpStdCInterface_8h_source.html#l00065">65</a> of file <a class="el" href="IpStdCInterface_8h_source.html">IpStdCInterface.h</a>.</p>

</div>
</div>
<a id="aab30234055c386ab38a7f50fffea65ed" name="aab30234055c386ab38a7f50fffea65ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab30234055c386ab38a7f50fffea65ed">&#9670;&#160;</a></span>Eval_F_CB</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef bool(* Eval_F_CB) (<a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> n, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *x, bool new_x, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *obj_value, <a class="el" href="IpStdCInterface_8h.html#a34729529d9e43f5954710164cafe4894">UserDataPtr</a> user_data)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Type defining the callback function for evaluating the value of the objective function. </p>
<p>Return value should be set to false if there was a problem doing the evaluation.</p>
<p>See also <a class="el" href="classIpopt_1_1TNLP.html#a709c03900227bc573b046ce0705e6c84" title="Method to request the value of the objective function.">Ipopt::TNLP::eval_f</a>. </p>

<p class="definition">Definition at line <a class="el" href="IpStdCInterface_8h_source.html#l00073">73</a> of file <a class="el" href="IpStdCInterface_8h_source.html">IpStdCInterface.h</a>.</p>

</div>
</div>
<a id="ae26561e1d9045d17521cb5f1e9992abb" name="ae26561e1d9045d17521cb5f1e9992abb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae26561e1d9045d17521cb5f1e9992abb">&#9670;&#160;</a></span>Eval_Grad_F_CB</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef bool(* Eval_Grad_F_CB) (<a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> n, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *x, bool new_x, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *grad_f, <a class="el" href="IpStdCInterface_8h.html#a34729529d9e43f5954710164cafe4894">UserDataPtr</a> user_data)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Type defining the callback function for evaluating the gradient of the objective function. </p>
<p>Return value should be set to false if there was a problem doing the evaluation.</p>
<p>See also <a class="el" href="classIpopt_1_1TNLP.html#a52698f1861ffef271d5e317c0e168652" title="Method to request the gradient of the objective function.">Ipopt::TNLP::eval_grad_f</a>. </p>

<p class="definition">Definition at line <a class="el" href="IpStdCInterface_8h_source.html#l00087">87</a> of file <a class="el" href="IpStdCInterface_8h_source.html">IpStdCInterface.h</a>.</p>

</div>
</div>
<a id="a5daaee1b7bfa5667670e788a91cae09f" name="a5daaee1b7bfa5667670e788a91cae09f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5daaee1b7bfa5667670e788a91cae09f">&#9670;&#160;</a></span>Eval_G_CB</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef bool(* Eval_G_CB) (<a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> n, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *x, bool new_x, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> m, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *g, <a class="el" href="IpStdCInterface_8h.html#a34729529d9e43f5954710164cafe4894">UserDataPtr</a> user_data)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Type defining the callback function for evaluating the value of the constraint functions. </p>
<p>Return value should be set to false if there was a problem doing the evaluation.</p>
<p>See also <a class="el" href="classIpopt_1_1TNLP.html#afcfd8404b772dc4960f2d2db4e8bb382" title="Method to request the constraint values.">Ipopt::TNLP::eval_g</a>. </p>

<p class="definition">Definition at line <a class="el" href="IpStdCInterface_8h_source.html#l00101">101</a> of file <a class="el" href="IpStdCInterface_8h_source.html">IpStdCInterface.h</a>.</p>

</div>
</div>
<a id="afdc0651b551e43ee347d208a4125d28c" name="afdc0651b551e43ee347d208a4125d28c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afdc0651b551e43ee347d208a4125d28c">&#9670;&#160;</a></span>Eval_Jac_G_CB</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef bool(* Eval_Jac_G_CB) (<a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> n, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *x, bool new_x, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> m, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> nele_jac, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> *iRow, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> *jCol, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *values, <a class="el" href="IpStdCInterface_8h.html#a34729529d9e43f5954710164cafe4894">UserDataPtr</a> user_data)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Type defining the callback function for evaluating the Jacobian of the constrant functions. </p>
<p>Return value should be set to false if there was a problem doing the evaluation.</p>
<p>See also <a class="el" href="classIpopt_1_1TNLP.html#aa4162d052f69d4f9946a42feec012853" title="Method to request either the sparsity structure or the values of the Jacobian of the constraints.">Ipopt::TNLP::eval_jac_g</a>. </p>

<p class="definition">Definition at line <a class="el" href="IpStdCInterface_8h_source.html#l00116">116</a> of file <a class="el" href="IpStdCInterface_8h_source.html">IpStdCInterface.h</a>.</p>

</div>
</div>
<a id="a5a8d4d98e2ba3178a1a8772d8dd4d3c2" name="a5a8d4d98e2ba3178a1a8772d8dd4d3c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a8d4d98e2ba3178a1a8772d8dd4d3c2">&#9670;&#160;</a></span>Eval_H_CB</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef bool(* Eval_H_CB) (<a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> n, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *x, bool new_x, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> obj_factor, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> m, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *lambda, bool new_lambda, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> nele_hess, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> *iRow, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> *jCol, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *values, <a class="el" href="IpStdCInterface_8h.html#a34729529d9e43f5954710164cafe4894">UserDataPtr</a> user_data)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Type defining the callback function for evaluating the Hessian of the Lagrangian function. </p>
<p>Return value should be set to false if there was a problem doing the evaluation.</p>
<p>See also <a class="el" href="classIpopt_1_1TNLP.html#a26b9145267e2574c53acc284fef1c354" title="Method to request either the sparsity structure or the values of the Hessian of the Lagrangian.">Ipopt::TNLP::eval_h</a>. </p>

<p class="definition">Definition at line <a class="el" href="IpStdCInterface_8h_source.html#l00134">134</a> of file <a class="el" href="IpStdCInterface_8h_source.html">IpStdCInterface.h</a>.</p>

</div>
</div>
<a id="a0a2bc6b1dc188466a5eed53a50dd15df" name="a0a2bc6b1dc188466a5eed53a50dd15df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a2bc6b1dc188466a5eed53a50dd15df">&#9670;&#160;</a></span>Intermediate_CB</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef bool(* Intermediate_CB) (<a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> alg_mod, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> iter_count, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> obj_value, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> inf_pr, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> inf_du, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> mu, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> d_norm, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> regularization_size, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> alpha_du, <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> alpha_pr, <a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a> ls_trials, <a class="el" href="IpStdCInterface_8h.html#a34729529d9e43f5954710164cafe4894">UserDataPtr</a> user_data)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Type defining the callback function for giving intermediate execution control to the user. </p>
<p>If set, it is called once per iteration, providing the user with some information on the state of the optimization. This can be used to print some user-defined output. It also gives the user a way to terminate the optimization prematurely. If this method returns false, <a class="el" href="namespaceIpopt.html" title="This file contains a base class for all exceptions and a set of macros to help with exceptions.">Ipopt</a> will terminate the optimization.</p>
<p>See also <a class="el" href="classIpopt_1_1TNLP.html#a2f962a4c43464adb7928771af84503d6" title="Intermediate Callback method for the user.">Ipopt::TNLP::intermediate_callback</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">alg_mod</td><td>algorithm mode: 0 is regular, 1 is restoration  </td></tr>
    <tr><td class="paramname">iter_count</td><td>iteration number  </td></tr>
    <tr><td class="paramname">obj_value</td><td>objective function value  </td></tr>
    <tr><td class="paramname">inf_pr</td><td>primal infeasibility  </td></tr>
    <tr><td class="paramname">inf_du</td><td>dual infeasibility  </td></tr>
    <tr><td class="paramname">mu</td><td>barrier parameter  </td></tr>
    <tr><td class="paramname">d_norm</td><td>infinity-norm of primal step  </td></tr>
    <tr><td class="paramname">regularization_size</td><td>size of regularization of Hessian of Lagrangian  </td></tr>
    <tr><td class="paramname">alpha_du</td><td>step length for dual variables  </td></tr>
    <tr><td class="paramname">alpha_pr</td><td>step length for primal variables  </td></tr>
    <tr><td class="paramname">ls_trials</td><td>number of backtracking line search steps  </td></tr>
    <tr><td class="paramname">user_data</td><td>user data </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="IpStdCInterface_8h_source.html#l00159">159</a> of file <a class="el" href="IpStdCInterface_8h_source.html">IpStdCInterface.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ad1c7c5bba4e9ca11142b12c1d434764e" name="ad1c7c5bba4e9ca11142b12c1d434764e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1c7c5bba4e9ca11142b12c1d434764e">&#9670;&#160;</a></span>CreateIpoptProblem()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a> <a class="el" href="IpStdCInterface_8h.html#ae32712b8d014ab2144fee84432e4a347">IpoptProblem</a> <a class="el" href="IpTypes_8h.html#ae7eaa5fbc2133bb2a78973a87cc7bb5b">IPOPT_CALLCONV</a> CreateIpoptProblem </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a>&#160;</td>
          <td class="paramname"><em>n</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *&#160;</td>
          <td class="paramname"><em>x_L</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *&#160;</td>
          <td class="paramname"><em>x_U</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a>&#160;</td>
          <td class="paramname"><em>m</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *&#160;</td>
          <td class="paramname"><em>g_L</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *&#160;</td>
          <td class="paramname"><em>g_U</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a>&#160;</td>
          <td class="paramname"><em>nele_jac</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a>&#160;</td>
          <td class="paramname"><em>nele_hess</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a>&#160;</td>
          <td class="paramname"><em>index_style</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpStdCInterface_8h.html#aab30234055c386ab38a7f50fffea65ed">Eval_F_CB</a>&#160;</td>
          <td class="paramname"><em>eval_f</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpStdCInterface_8h.html#a5daaee1b7bfa5667670e788a91cae09f">Eval_G_CB</a>&#160;</td>
          <td class="paramname"><em>eval_g</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpStdCInterface_8h.html#ae26561e1d9045d17521cb5f1e9992abb">Eval_Grad_F_CB</a>&#160;</td>
          <td class="paramname"><em>eval_grad_f</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpStdCInterface_8h.html#afdc0651b551e43ee347d208a4125d28c">Eval_Jac_G_CB</a>&#160;</td>
          <td class="paramname"><em>eval_jac_g</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpStdCInterface_8h.html#a5a8d4d98e2ba3178a1a8772d8dd4d3c2">Eval_H_CB</a>&#160;</td>
          <td class="paramname"><em>eval_h</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Function for creating a new <a class="el" href="namespaceIpopt.html" title="This file contains a base class for all exceptions and a set of macros to help with exceptions.">Ipopt</a> Problem object. </p>
<p>This function returns an object that can be passed to the IpoptSolve call. It contains the basic definition of the optimization problem, such as number of variables and constraints, bounds on variables and constraints, information about the derivatives, and the callback function for the computation of the optimization problem functions and derivatives. During this call, the options file PARAMS.DAT is read as well.</p>
<p>If NULL is returned, there was a problem with one of the inputs or reading the options file.</p>
<p>See also <a class="el" href="classIpopt_1_1TNLP.html#a5da5791365764706aeda02b78f7719b6" title="Method to request the initial information about the problem.">Ipopt::TNLP::get_nlp_info</a> and <a class="el" href="classIpopt_1_1TNLP.html#aafb65734cce3659c6fb496e136636e9e" title="Method to request bounds on the variables and constraints.">Ipopt::TNLP::get_bounds_info</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">n</td><td>Number of optimization variables  </td></tr>
    <tr><td class="paramname">x_L</td><td>Lower bounds on variables</td></tr>
  </table>
  </dd>
</dl>
<p>This array of size n is copied internally, so that the caller can change the incoming data after return without that IpoptProblem is modified. Any value less or equal than the number specified by option 'nlp_lower_bound_inf' is interpreted to be minus infinity.  </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">x_U</td><td>Upper bounds on variables</td></tr>
  </table>
  </dd>
</dl>
<p>This array of size n is copied internally, so that the caller can change the incoming data after return without that IpoptProblem is modified. Any value greater or equal than the number specified by option 'nlp_upper_bound_inf' is interpreted to be plus infinity.  </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">m</td><td>Number of constraints  </td></tr>
    <tr><td class="paramname">g_L</td><td>Lower bounds on constraints</td></tr>
  </table>
  </dd>
</dl>
<p>This array of size m is copied internally, so that the caller can change the incoming data after return without that IpoptProblem is modified. Any value less or equal than the number specified by option 'nlp_lower_bound_inf' is interpreted to be minus infinity.  </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">g_U</td><td>Upper bounds on constraints</td></tr>
  </table>
  </dd>
</dl>
<p>This array of size m is copied internally, so that the caller can change the incoming data after return without that IpoptProblem is modified. Any value greater or equal than the number specified by option 'nlp_upper_bound_inf' is interpreted to be plus infinity.  </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">nele_jac</td><td>Number of non-zero elements in constraint Jacobian  </td></tr>
    <tr><td class="paramname">nele_hess</td><td>Number of non-zero elements in Hessian of Lagrangian  </td></tr>
    <tr><td class="paramname">index_style</td><td>Indexing style for iRow &amp; jCol, 0 for C style, 1 for Fortran style  </td></tr>
    <tr><td class="paramname">eval_f</td><td>Callback function for evaluating objective function  </td></tr>
    <tr><td class="paramname">eval_g</td><td>Callback function for evaluating constraint functions  </td></tr>
    <tr><td class="paramname">eval_grad_f</td><td>Callback function for evaluating gradient of objective function  </td></tr>
    <tr><td class="paramname">eval_jac_g</td><td>Callback function for evaluating Jacobian of constraint functions  </td></tr>
    <tr><td class="paramname">eval_h</td><td>Callback function for evaluating Hessian of Lagrangian function </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a2776b701c950d9700509f1e601d787f6" name="a2776b701c950d9700509f1e601d787f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2776b701c950d9700509f1e601d787f6">&#9670;&#160;</a></span>FreeIpoptProblem()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a> void <a class="el" href="IpTypes_8h.html#ae7eaa5fbc2133bb2a78973a87cc7bb5b">IPOPT_CALLCONV</a> FreeIpoptProblem </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="IpStdCInterface_8h.html#ae32712b8d014ab2144fee84432e4a347">IpoptProblem</a>&#160;</td>
          <td class="paramname"><em>ipopt_problem</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Method for freeing a previously created IpoptProblem. </p>
<p>After freeing an IpoptProblem, it cannot be used anymore. </p>

</div>
</div>
<a id="ab6b7c62bfbc8dea71b3a6f724c36b377" name="ab6b7c62bfbc8dea71b3a6f724c36b377"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab6b7c62bfbc8dea71b3a6f724c36b377">&#9670;&#160;</a></span>AddIpoptStrOption()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a> bool <a class="el" href="IpTypes_8h.html#ae7eaa5fbc2133bb2a78973a87cc7bb5b">IPOPT_CALLCONV</a> AddIpoptStrOption </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="IpStdCInterface_8h.html#ae32712b8d014ab2144fee84432e4a347">IpoptProblem</a>&#160;</td>
          <td class="paramname"><em>ipopt_problem</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>keyword</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>val</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Function for adding a string option. </p>
<dl class="section return"><dt>Returns</dt><dd>false, if the option could not be set (e.g., if keyword is unknown) </dd></dl>

</div>
</div>
<a id="a7af9acc5df419794044bc4c6717a89ca" name="a7af9acc5df419794044bc4c6717a89ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7af9acc5df419794044bc4c6717a89ca">&#9670;&#160;</a></span>AddIpoptNumOption()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a> bool <a class="el" href="IpTypes_8h.html#ae7eaa5fbc2133bb2a78973a87cc7bb5b">IPOPT_CALLCONV</a> AddIpoptNumOption </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="IpStdCInterface_8h.html#ae32712b8d014ab2144fee84432e4a347">IpoptProblem</a>&#160;</td>
          <td class="paramname"><em>ipopt_problem</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>keyword</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a>&#160;</td>
          <td class="paramname"><em>val</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Function for adding a Number option. </p>
<dl class="section return"><dt>Returns</dt><dd>false, if the option could not be set (e.g., if keyword is unknown) </dd></dl>

</div>
</div>
<a id="a408cfbc4c2e69def583fd8c0ca85d88c" name="a408cfbc4c2e69def583fd8c0ca85d88c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a408cfbc4c2e69def583fd8c0ca85d88c">&#9670;&#160;</a></span>AddIpoptIntOption()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a> bool <a class="el" href="IpTypes_8h.html#ae7eaa5fbc2133bb2a78973a87cc7bb5b">IPOPT_CALLCONV</a> AddIpoptIntOption </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="IpStdCInterface_8h.html#ae32712b8d014ab2144fee84432e4a347">IpoptProblem</a>&#160;</td>
          <td class="paramname"><em>ipopt_problem</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>keyword</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a>&#160;</td>
          <td class="paramname"><em>val</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Function for adding an Integer option. </p>
<dl class="section return"><dt>Returns</dt><dd>false, if the option could not be set (e.g., if keyword is unknown) @ </dd></dl>

</div>
</div>
<a id="a217bdf5c36c19c81b44fab50d8af8a8a" name="a217bdf5c36c19c81b44fab50d8af8a8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a217bdf5c36c19c81b44fab50d8af8a8a">&#9670;&#160;</a></span>OpenIpoptOutputFile()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a> bool <a class="el" href="IpTypes_8h.html#ae7eaa5fbc2133bb2a78973a87cc7bb5b">IPOPT_CALLCONV</a> OpenIpoptOutputFile </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="IpStdCInterface_8h.html#ae32712b8d014ab2144fee84432e4a347">IpoptProblem</a>&#160;</td>
          <td class="paramname"><em>ipopt_problem</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>file_name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>print_level</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Function for opening an output file for a given name with given printlevel. </p>
<dl class="section return"><dt>Returns</dt><dd>false, if there was a problem opening the file. </dd></dl>

</div>
</div>
<a id="afe4f90a0c6f89253924c7afb067f87e2" name="afe4f90a0c6f89253924c7afb067f87e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe4f90a0c6f89253924c7afb067f87e2">&#9670;&#160;</a></span>SetIpoptProblemScaling()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a> bool <a class="el" href="IpTypes_8h.html#ae7eaa5fbc2133bb2a78973a87cc7bb5b">IPOPT_CALLCONV</a> SetIpoptProblemScaling </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="IpStdCInterface_8h.html#ae32712b8d014ab2144fee84432e4a347">IpoptProblem</a>&#160;</td>
          <td class="paramname"><em>ipopt_problem</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a>&#160;</td>
          <td class="paramname"><em>obj_scaling</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *&#160;</td>
          <td class="paramname"><em>x_scaling</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *&#160;</td>
          <td class="paramname"><em>g_scaling</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Optional function for setting scaling parameter for the NLP. </p>
<p>This corresponds to the TNLP::get_scaling_parameters method. If the pointers x_scaling or g_scaling are NULL, then no scaling for x resp. g is done. </p>

</div>
</div>
<a id="ab86b55545fa3e0232a0e646409e0e82b" name="ab86b55545fa3e0232a0e646409e0e82b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab86b55545fa3e0232a0e646409e0e82b">&#9670;&#160;</a></span>SetIntermediateCallback()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a> bool <a class="el" href="IpTypes_8h.html#ae7eaa5fbc2133bb2a78973a87cc7bb5b">IPOPT_CALLCONV</a> SetIntermediateCallback </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="IpStdCInterface_8h.html#ae32712b8d014ab2144fee84432e4a347">IpoptProblem</a>&#160;</td>
          <td class="paramname"><em>ipopt_problem</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpStdCInterface_8h.html#a0a2bc6b1dc188466a5eed53a50dd15df">Intermediate_CB</a>&#160;</td>
          <td class="paramname"><em>intermediate_cb</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Setting a callback function for the "intermediate callback" method in the TNLP. </p>
<p>This gives control back to the user once per iteration. If set, it provides the user with some information on the state of the optimization. This can be used to print some user-defined output. It also gives the user a way to terminate the optimization prematurely. If the callback method returns false, <a class="el" href="namespaceIpopt.html" title="This file contains a base class for all exceptions and a set of macros to help with exceptions.">Ipopt</a> will terminate the optimization. Calling this set method to set the CB pointer to NULL disables the intermediate callback functionality. </p>

</div>
</div>
<a id="a5a68928c505f008c1245088bca5b7b16" name="a5a68928c505f008c1245088bca5b7b16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a68928c505f008c1245088bca5b7b16">&#9670;&#160;</a></span>IpoptSolve()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a> enum <a class="el" href="IpReturnCodes__inc_8h.html#ab542e0b1ca364a9b7525a876ffdae7d7">ApplicationReturnStatus</a> <a class="el" href="IpTypes_8h.html#ae7eaa5fbc2133bb2a78973a87cc7bb5b">IPOPT_CALLCONV</a> IpoptSolve </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="IpStdCInterface_8h.html#ae32712b8d014ab2144fee84432e4a347">IpoptProblem</a>&#160;</td>
          <td class="paramname"><em>ipopt_problem</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *&#160;</td>
          <td class="paramname"><em>g</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *&#160;</td>
          <td class="paramname"><em>obj_val</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *&#160;</td>
          <td class="paramname"><em>mult_g</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *&#160;</td>
          <td class="paramname"><em>mult_x_L</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *&#160;</td>
          <td class="paramname"><em>mult_x_U</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpStdCInterface_8h.html#a34729529d9e43f5954710164cafe4894">UserDataPtr</a>&#160;</td>
          <td class="paramname"><em>user_data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Function calling the <a class="el" href="namespaceIpopt.html" title="This file contains a base class for all exceptions and a set of macros to help with exceptions.">Ipopt</a> optimization algorithm for a problem previously defined with CreateIpoptProblem. </p>
<dl class="section return"><dt>Returns</dt><dd>outcome of the optimization procedure (e.g., success, failure etc). </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ipopt_problem</td><td>Problem that is to be optimized.</td></tr>
  </table>
  </dd>
</dl>
<p><a class="el" href="namespaceIpopt.html" title="This file contains a base class for all exceptions and a set of macros to help with exceptions.">Ipopt</a> will use the options previously specified with AddIpoptOption (etc) for this problem.  </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">x</td><td>Input: Starting point; Output: Optimal solution  </td></tr>
    <tr><td class="paramname">g</td><td>Values of constraint at final point (output only; ignored if set to NULL)  </td></tr>
    <tr><td class="paramname">obj_val</td><td>Final value of objective function (output only; ignored if set to NULL)  </td></tr>
    <tr><td class="paramname">mult_g</td><td>Input: Initial values for the constraint multipliers (only if warm start option is chosen); Output: Final multipliers for constraints (ignored if set to NULL)  </td></tr>
    <tr><td class="paramname">mult_x_L</td><td>Input: Initial values for the multipliers for lower variable bounds (only if warm start option is chosen); Output: Final multipliers for lower variable bounds (ignored if set to NULL)  </td></tr>
    <tr><td class="paramname">mult_x_U</td><td>Input: Initial values for the multipliers for upper variable bounds (only if warm start option is chosen); Output: Final multipliers for upper variable bounds (ignored if set to NULL)  </td></tr>
    <tr><td class="paramname">user_data</td><td>Pointer to user data.</td></tr>
  </table>
  </dd>
</dl>
<p>This will be passed unmodified to the callback functions. </p>

</div>
</div>
<a id="acf68350650b7a893061e110ab0e9264f" name="acf68350650b7a893061e110ab0e9264f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf68350650b7a893061e110ab0e9264f">&#9670;&#160;</a></span>GetIpoptCurrentIterate()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a> bool <a class="el" href="IpTypes_8h.html#ae7eaa5fbc2133bb2a78973a87cc7bb5b">IPOPT_CALLCONV</a> GetIpoptCurrentIterate </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="IpStdCInterface_8h.html#ae32712b8d014ab2144fee84432e4a347">IpoptProblem</a>&#160;</td>
          <td class="paramname"><em>ipopt_problem</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>scaled</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a>&#160;</td>
          <td class="paramname"><em>n</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *&#160;</td>
          <td class="paramname"><em>z_L</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *&#160;</td>
          <td class="paramname"><em>z_U</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a>&#160;</td>
          <td class="paramname"><em>m</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *&#160;</td>
          <td class="paramname"><em>g</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *&#160;</td>
          <td class="paramname"><em>lambda</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get primal and dual variable values of the current iterate. </p>
<p>This method can be used to get the values of the current iterate during the intermediate callback set by <a class="el" href="IpStdCInterface_8h.html#ab86b55545fa3e0232a0e646409e0e82b" title="Setting a callback function for the &quot;intermediate callback&quot; method in the TNLP.">SetIntermediateCallback()</a>. The method expects the number of variables (dimension of x), number of constraints (dimension of g(x)), and allocated arrays of appropriate lengths as input.</p>
<p>The method translates the x(), c(), d(), y_c(), y_d(), z_L(), and z_U() vectors from <a class="el" href="classIpopt_1_1IpoptData.html#a7ea3aeb9b62b340f7671d61b88a9b056" title="Current point.">Ipopt::IpoptData::curr()</a> of the internal NLP representation into the form used by the TNLP. For the correspondence between scaled and unscaled solutions, see the detailed description of <a class="el" href="classIpopt_1_1OrigIpoptNLP.html" title="This class maps the traditional NLP into something that is more useful for Ipopt.">Ipopt::OrigIpoptNLP</a>. If Ipopt is in restoration mode, it maps the current iterate of restoration NLP (see <a class="el" href="classIpopt_1_1RestoIpoptNLP.html" title="This class maps a IpoptNLP into one that is used for the restoration phase of Ipopt.">Ipopt::RestoIpoptNLP</a>) back to the original TNLP.</p>
<p>If there are fixed variables and fixed_variable_treatment=make_parameter, then requesting z_L and z_U can trigger a reevaluation of the Gradient of the objective function and the Jacobian of the constraint functions.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ipopt_problem</td><td>(in) Problem that is currently optimized. </td></tr>
    <tr><td class="paramname">n</td><td>(in) the number of variables \(x\) in the problem; can be arbitrary if skipping x, z_L, and z_U </td></tr>
    <tr><td class="paramname">scaled</td><td>(in) whether to retrieve scaled or unscaled iterate </td></tr>
    <tr><td class="paramname">x</td><td>(out) buffer to store value of primal variables \(x\), must have length at least n; pass NULL to skip retrieving x </td></tr>
    <tr><td class="paramname">z_L</td><td>(out) buffer to store the lower bound multipliers \(z_L\), must have length at least n; pass NULL to skip retrieving z_L and Z_U </td></tr>
    <tr><td class="paramname">z_U</td><td>(out) buffer to store the upper bound multipliers \(z_U\), must have length at least n; pass NULL to skip retrieving z_L and Z_U </td></tr>
    <tr><td class="paramname">m</td><td>(in) the number of constraints \(g(x)\); can be arbitrary if skipping g and lambda </td></tr>
    <tr><td class="paramname">g</td><td>(out) buffer to store the constraint values \(g(x)\), must have length at least m; pass NULL to skip retrieving g </td></tr>
    <tr><td class="paramname">lambda</td><td>(out) buffer to store the constraint multipliers \(\lambda\), must have length at least m; pass NULL to skip retrieving lambda</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Whether <a class="el" href="namespaceIpopt.html" title="This file contains a base class for all exceptions and a set of macros to help with exceptions.">Ipopt</a> has successfully filled the given arrays </dd></dl>
<dl class="section since"><dt>Since</dt><dd>3.14.0 </dd></dl>

</div>
</div>
<a id="ae505cff0e907b9049062f665dadd8be9" name="ae505cff0e907b9049062f665dadd8be9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae505cff0e907b9049062f665dadd8be9">&#9670;&#160;</a></span>GetIpoptCurrentViolations()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="config__default_8h.html#a58bb5c104ee5ff44b7175fc992d89b0b">IPOPTLIB_EXPORT</a> bool <a class="el" href="IpTypes_8h.html#ae7eaa5fbc2133bb2a78973a87cc7bb5b">IPOPT_CALLCONV</a> GetIpoptCurrentViolations </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="IpStdCInterface_8h.html#ae32712b8d014ab2144fee84432e4a347">IpoptProblem</a>&#160;</td>
          <td class="paramname"><em>ipopt_problem</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>scaled</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a>&#160;</td>
          <td class="paramname"><em>n</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *&#160;</td>
          <td class="paramname"><em>x_L_violation</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *&#160;</td>
          <td class="paramname"><em>x_U_violation</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *&#160;</td>
          <td class="paramname"><em>compl_x_L</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *&#160;</td>
          <td class="paramname"><em>compl_x_U</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *&#160;</td>
          <td class="paramname"><em>grad_lag_x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#ad45d5b046bfaf56789665c747d5a8cb9">ipindex</a>&#160;</td>
          <td class="paramname"><em>m</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *&#160;</td>
          <td class="paramname"><em>nlp_constraint_violation</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> *&#160;</td>
          <td class="paramname"><em>compl_g</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get primal and dual infeasibility of the current iterate. </p>
<p>This method can be used to get the violations of constraints and optimality conditions at the current iterate during the intermediate callback set by <a class="el" href="IpStdCInterface_8h.html#ab86b55545fa3e0232a0e646409e0e82b" title="Setting a callback function for the &quot;intermediate callback&quot; method in the TNLP.">SetIntermediateCallback()</a>. The method expects the number of variables (dimension of x), number of constraints (dimension of g(x)), and allocated arrays of appropriate lengths as input.</p>
<p>The method makes the vectors behind (unscaled_)curr_orig_bounds_violation(), (unscaled_)curr_nlp_constraint_violation(), (unscaled_)curr_dual_infeasibility(), (unscaled_)curr_complementarity() from <a class="el" href="classIpopt_1_1IpoptCalculatedQuantities.html" title="Class for all IPOPT specific calculated quantities.">Ipopt::IpoptCalculatedQuantities</a> of the internal NLP representation available into the form used by the TNLP. If Ipopt is in restoration mode, it maps the current iterate of restoration NLP (see <a class="el" href="classIpopt_1_1RestoIpoptNLP.html" title="This class maps a IpoptNLP into one that is used for the restoration phase of Ipopt.">Ipopt::RestoIpoptNLP</a>) back to the original TNLP.</p>
<dl class="section note"><dt>Note</dt><dd>If in restoration phase, then requesting grad_lag_x can trigger a call to Eval_F_CB.</dd>
<dd>
<a class="el" href="namespaceIpopt.html" title="This file contains a base class for all exceptions and a set of macros to help with exceptions.">Ipopt</a> by default relaxes variable bounds (option bound_relax_factor &gt; 0.0). x_L_violation and x_U_violation report the violation of a solution w.r.t. the original unrelaxed bounds. However, compl_x_L and compl_x_U use the relaxed variable bounds to calculate the complementarity.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ipopt_problem</td><td>(in) Problem that is currently optimized. </td></tr>
    <tr><td class="paramname">scaled</td><td>(in) whether to retrieve scaled or unscaled violations </td></tr>
    <tr><td class="paramname">n</td><td>(in) the number of variables \(x\) in the problem; can be arbitrary if skipping compl_x_L, compl_x_U, and grad_lag_x </td></tr>
    <tr><td class="paramname">x_L_violation</td><td>(out) buffer to store violation of original lower bounds on variables (max(orig_x_L-x,0)), must have length at least n; pass NULL to skip retrieving orig_x_L </td></tr>
    <tr><td class="paramname">x_U_violation</td><td>(out) buffer to store violation of original upper bounds on variables (max(x-orig_x_U,0)), must have length at least n; pass NULL to skip retrieving orig_x_U </td></tr>
    <tr><td class="paramname">compl_x_L</td><td>(out) buffer to store violation of complementarity for lower bounds on variables ( \((x-x_L)z_L\)), must have length at least n; pass NULL to skip retrieving compl_x_L </td></tr>
    <tr><td class="paramname">compl_x_U</td><td>(out) buffer to store violation of complementarity for upper bounds on variables ( \((x_U-x)z_U\)), must have length at least n; pass NULL to skip retrieving compl_x_U </td></tr>
    <tr><td class="paramname">grad_lag_x</td><td>(out) buffer to store gradient of Lagrangian w.r.t. variables \(x\), must have length at least n; pass NULL to skip retrieving grad_lag_x </td></tr>
    <tr><td class="paramname">m</td><td>(in) the number of constraints \(g(x)\); can be arbitrary if skipping lambda </td></tr>
    <tr><td class="paramname">nlp_constraint_violation</td><td>(out) buffer to store violation of constraints \(max(g_l-g(x),g(x)-g_u,0)\), must have length at least m; pass NULL to skip retrieving constraint_violation </td></tr>
    <tr><td class="paramname">compl_g</td><td>(out) buffer to store violation of complementarity of constraint ( \((g(x)-g_l)*\lambda^+ + (g_l-g(x))*\lambda^-\), where \(\lambda^+=max(0,\lambda)\) and \(\lambda^-=max(0,-\lambda)\) (componentwise)), must have length at least m; pass NULL to skip retrieving compl_g</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Whether <a class="el" href="namespaceIpopt.html" title="This file contains a base class for all exceptions and a set of macros to help with exceptions.">Ipopt</a> has successfully filled the given arrays </dd></dl>
<dl class="section since"><dt>Since</dt><dd>3.14.0 </dd></dl>

</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="ab974f23c40ccaad0dacd611e3f4885e9" name="ab974f23c40ccaad0dacd611e3f4885e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab974f23c40ccaad0dacd611e3f4885e9">&#9670;&#160;</a></span>Number</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="IpTypes_8h.html#a24c578b20e2cd4eeb0060056ea13cbe5">IPOPT_DEPRECATED</a> typedef <a class="el" href="IpTypes_8h.html#a5db07e705790a30d1c9081e6910c8b27">ipnumber</a> Number</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Type for all number. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000016">Deprecated:</a></b></dt><dd>Use ipnumber instead. </dd></dl>

<p class="definition">Definition at line <a class="el" href="IpStdCInterface_8h_source.html#l00031">31</a> of file <a class="el" href="IpStdCInterface_8h_source.html">IpStdCInterface.h</a>.</p>

</div>
</div>
<a id="ac3aa63858b3377c5aaf789a43e5b47b5" name="ac3aa63858b3377c5aaf789a43e5b47b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3aa63858b3377c5aaf789a43e5b47b5">&#9670;&#160;</a></span>Index</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="IpTypes_8h.html#a24c578b20e2cd4eeb0060056ea13cbe5">IPOPT_DEPRECATED</a> typedef int Index</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Type for all indices. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000017">Deprecated:</a></b></dt><dd>Use ipindex instead. </dd></dl>

<p class="definition">Definition at line <a class="el" href="IpStdCInterface_8h_source.html#l00037">37</a> of file <a class="el" href="IpStdCInterface_8h_source.html">IpStdCInterface.h</a>.</p>

</div>
</div>
<a id="a981fcddf5a1e9bbdc3d71ef0f994259b" name="a981fcddf5a1e9bbdc3d71ef0f994259b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a981fcddf5a1e9bbdc3d71ef0f994259b">&#9670;&#160;</a></span>Int</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="IpTypes_8h.html#a24c578b20e2cd4eeb0060056ea13cbe5">IPOPT_DEPRECATED</a> typedef int Int</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Type for all integers. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000018">Deprecated:</a></b></dt><dd>Use int instead. </dd></dl>

<p class="definition">Definition at line <a class="el" href="IpStdCInterface_8h_source.html#l00043">43</a> of file <a class="el" href="IpStdCInterface_8h_source.html">IpStdCInterface.h</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
</body>
</html>
